flattenlistmodel: Convert docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 1 Mar 2021 06:37:37 +0000 (01:37 -0500)
committerEmmanuele Bassi <ebassi@gnome.org>
Thu, 11 Mar 2021 16:37:36 +0000 (16:37 +0000)
gtk/gtkflattenlistmodel.c

index cea983f8da4c9292aa203b662e2e5fcc5a6876c4..6d7974d4e6a235488a834c4fe930c4ca9df3c6ae 100644 (file)
 #include "gtkprivate.h"
 
 /**
- * SECTION:gtkflattenlistmodel
- * @title: GtkFlattenListModel
- * @short_description: A list model that flattens a list of lists
- * @see_also: #GListModel
+ * GtkFlattenListModel:
  *
- * #GtkFlattenListModel is a list model that takes a list model containing
- * list models and flattens it into a single model.
+ * `GtkFlattenListModel` is a list model that concatenates other list models.
  *
- * Another term for this is concatenation: #GtkFlattenListModel takes a
- * list of lists and concatenates them into a single list.
+ * `GtkFlattenListModel` takes a list model containing list models,
+ *  and flattens it into a single model.
  */
 
 enum {
@@ -404,9 +400,9 @@ gtk_flatten_list_model_class_init (GtkFlattenListModelClass *class)
   gobject_class->dispose = gtk_flatten_list_model_dispose;
 
   /**
-   * GtkFlattenListModel:model:
+   * GtkFlattenListModel:model: (attributes org.gtk.Property.get=gtk_flatten_list_model_get_model org.gtk.Property.set=gtk_flatten_list_model_set_model)
    *
-   * The model being flattened
+   * The model being flattened.
    */
   properties[PROP_MODEL] =
       g_param_spec_object ("model",
@@ -427,10 +423,10 @@ gtk_flatten_list_model_init (GtkFlattenListModel *self)
  * gtk_flatten_list_model_new:
  * @model: (nullable) (transfer full): the model to be flattened
  *
- * Creates a new #GtkFlattenListModel that flattens @list.
+ * Creates a new `GtkFlattenListModel` that flattens @list.
  *
- * Returns: a new #GtkFlattenListModel
- **/
+ * Returns: a new `GtkFlattenListModel`
+ */
 GtkFlattenListModel *
 gtk_flatten_list_model_new (GListModel *model)
 {
@@ -449,12 +445,12 @@ gtk_flatten_list_model_new (GListModel *model)
 }
 
 /**
- * gtk_flatten_list_model_set_model:
- * @self: a #GtkFlattenListModel
+ * gtk_flatten_list_model_set_model: (attributes org.gtk.Method.set_property=model)
+ * @self: a `GtkFlattenListModel`
  * @model: (nullable) (transfer none): the new model or %NULL
  *
  * Sets a new model to be flattened.
- **/
+ */
 void
 gtk_flatten_list_model_set_model (GtkFlattenListModel *self,
                                   GListModel          *model)
@@ -492,8 +488,8 @@ gtk_flatten_list_model_set_model (GtkFlattenListModel *self,
 }
 
 /**
- * gtk_flatten_list_model_get_model:
- * @self: a #GtkFlattenListModel
+ * gtk_flatten_list_model_get_model: (attributes org.gtk.Method.get_property=model)
+ * @self: a `GtkFlattenListModel`
  *
  * Gets the model set via gtk_flatten_list_model_set_model().
  *
@@ -509,7 +505,7 @@ gtk_flatten_list_model_get_model (GtkFlattenListModel *self)
 
 /**
  * gtk_flatten_list_model_get_model_for_item:
- * @self: a #GtkFlattenListModel
+ * @self: a `GtkFlattenListModel`
  * @position: a position
  *
  * Returns the model containing the item at the given position.